Angular Resource Plugin #2423

max-scopp · 2025-08-11T11:30:10Z

Builds on top of #2422

- Updated `openapi-ts.config.ts` to configure Angular client plugin with error handling option. - Modified `app.component.html` to use a demo component for displaying pet information. - Refactored `app.component.ts` to remove direct API calls and integrate with the new demo component. - Enhanced `app.config.ts` to provide the Hey API client for dependency injection. - Improved error handling in client utilities and response processing. - Added new demo component with HTML and CSS for displaying pet information and error messages. - Updated client generation scripts to support new error handling and response structures. - Refactored HTTP client usage to support custom injectors and improved error response handling.

…yId method

…onBodySerializer import

…ration - Introduced `types.gen.ts` for TypeScript types related to API requests and responses. - Created `sdk.gen.ts` to define SDK functions for interacting with the API. - Added `schemas.gen.ts` to define data schemas for various entities like Order, User, Pet, etc. - Implemented `index.ts` to export SDK and types for easier access. - Developed `main.ts` and `main.server.ts` for bootstrapping the Angular application. - Set up server-side rendering with Express in `server.ts`. - Included basic HTML structure in `index.html`. - Configured TypeScript settings in `tsconfig` files for application and testing. - Added global styles in `styles.css`.

bolt-new-by-stackblitz · 2025-08-11T11:30:14Z

Run & review this pull request in StackBlitz Codeflow.

changeset-bot · 2025-08-11T11:30:15Z

🦋 Changeset detected

Latest commit: 554e9a6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@hey-api/openapi-ts	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2025-08-11T11:30:15Z

@max-scopp is attempting to deploy a commit to the Hey API Team on Vercel.

A member of the Team first needs to authorize it.

codecov · 2025-08-11T11:44:15Z

Codecov Report

❌ Patch coverage is 11.24567% with 513 lines in your changes missing coverage. Please review.
✅ Project coverage is 22.59%. Comparing base (78c9caf) to head (554e9a6).

Files with missing lines	Patch %	Lines
...nions/angularHttpRequestsCompanionPluginHandler.ts	4.62%	309 Missing ⚠️
...nions/angularHttpResourceCompanionPluginHandler.ts	8.42%	87 Missing ⚠️
...c/plugins/@hey-api/client-angular/bundle/client.ts	5.79%	65 Missing ⚠️
...s/openapi-ts/src/plugins/@angular/common/config.ts	28.20%	28 Missing ⚠️
...rc/plugins/@hey-api/client-angular/bundle/utils.ts	60.60%	13 Missing ⚠️
...s/openapi-ts/src/plugins/@angular/common/plugin.ts	37.50%	5 Missing ⚠️
...ages/openapi-ts/src/plugins/@hey-api/sdk/config.ts	16.66%	5 Missing ⚠️
...ages/openapi-ts/src/plugins/@hey-api/sdk/plugin.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2423      +/-   ##
==========================================
- Coverage   22.84%   22.59%   -0.25%     
==========================================
  Files         334      336       +2     
  Lines       32948    33366     +418     
  Branches     1309     1309              
==========================================
+ Hits         7526     7540      +14     
- Misses      25413    25817     +404     
  Partials        9        9

Flag	Coverage Δ
unittests	`22.59% <11.24%> (-0.25%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

pkg-pr-new · 2025-08-11T12:06:05Z

Open in StackBlitz

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/nuxt@2423

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/openapi-ts@2423

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/vite-plugin@2423

commit: 554e9a6

- Added `httpResource` and `httpRequest` companion plugin handlers to generate Angular services and functions for API operations. - Introduced `PetResources`, `StoreResources`, and `UserResources` classes for managing pet store operations. - Enhanced configuration options for HTTP resources and requests, allowing customization of class and method names. - Generated TypeScript definitions for Angular HTTP resource and request options. - Updated plugin handler to conditionally enable HTTP resource generation based on configuration.

…tomization

vercel · 2025-08-14T11:07:09Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project	Deployment	Preview	Comments	Updated (UTC)
hey-api-docs	✅ Ready	Preview	Comment	Aug 14, 2025 11:09am

mrlubos · 2025-08-14T12:39:44Z

packages/openapi-ts/src/plugins/@hey-api/sdk/config.ts

+    // Set default classNameBuilder based on client type
+    if (plugin.config.classNameBuilder === '{{name}}') {
+      if (plugin.config.client === '@hey-api/client-angular') {
+        plugin.config.classNameBuilder = '{{name}}Service';
+      }
+    }


If you don't have a custom class name builder and you use the angular client and want to create classes with asClass: true, suffix the classes with "Service" to avoid potential clashing names of the same interface and controller/class name. I did this because in the Pet store, this would result in the class and endpoints for Pet, as well, as the interface for one Pet's response

I think we might need to come back to this one at some point. It feels dirty. I have no problem with accepting it for now but maybe we want to add some comments around why it's done that way

Yes I'm also conflicted about this, for now the Service suffix is still widely accepted by Angular devs, but they too would prefer to move away from this pattern

packages/openapi-ts/src/plugins/config.ts

packages/openapi-ts/src/ir/context.ts

packages/openapi-ts/src/generate/legacy/output.ts

mrlubos · 2025-08-14T12:41:36Z

docs/openapi-ts/clients/angular.md

Note to myself: update this later

… consistency

…max-scopp/openapi-ts into feature/angular-resource-plugin

max-scopp added 5 commits August 11, 2025 11:39

refactor: remove unused client and httpClient parameters from getPetB…

2166d56

…yId method

refactor: remove unused plugins

3ad1359

fix: update tanstack example, serializedBody handling and clean up js…

2996bde

…onBodySerializer import

dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. feature 🚀 New feature or request labels Aug 11, 2025

max-scopp mentioned this pull request Aug 11, 2025

Angular client #1072

Closed

fix: update package name to include 'resource' for clarity

3d933d9

max-scopp mentioned this pull request Aug 11, 2025

feat: Refactor Angular client integration and enhance error handling #2422

Closed

fix: update setAuthParams to use HttpHeaders and improve header handling

000eebe

max-scopp and others added 5 commits August 11, 2025 21:46

docs: add Angular client documentation

6ab6bb5

feat: Enhance Angular SDK with injectable services and class name cus…

2dd4461

…tomization

fix: ensure outputParts is a string before splitting

40a9db7

Merge branch 'main' into feature/angular-resource-plugin

f90734d

mrlubos approved these changes Aug 14, 2025

View reviewed changes

dosubot bot added the lgtm This PR has been approved by a maintainer label Aug 14, 2025

vercel bot deployed to Preview August 14, 2025 11:08 View deployment

mrlubos requested changes Aug 14, 2025

View reviewed changes

dosubot bot removed the lgtm This PR has been approved by a maintainer label Aug 14, 2025

mrlubos reviewed Aug 14, 2025

View reviewed changes

docs/openapi-ts/clients/angular.md Outdated

Copy link

Member

mrlubos Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note to myself: update this later

max-scopp added 2 commits August 14, 2025 15:19

refactor: rename HeyApiAngularCommonPlugin to AngularCommonPlugin for…

885c887

… consistency

Merge branch 'feature/angular-resource-plugin' of https://github.com/…

1b76c64

…max-scopp/openapi-ts into feature/angular-resource-plugin

fix: update output handling in plugins and add output documentation

8e00fa9

mrlubos previously approved these changes Aug 14, 2025

View reviewed changes

dosubot bot added the lgtm This PR has been approved by a maintainer label Aug 14, 2025

Create slimy-news-juggle.md

554e9a6

mrlubos dismissed their stale review via 554e9a6 August 14, 2025 13:43

mrlubos approved these changes Aug 14, 2025

View reviewed changes

mrlubos merged commit 937a874 into hey-api:main Aug 14, 2025
13 of 16 checks passed

This was referenced Aug 14, 2025

Version Packages #2441

Merged

Version Packages florence-wolfe/openapi-ts#252

Open

Version Packages stungkit/openapi-ts#206

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Angular Resource Plugin #2423

Angular Resource Plugin #2423

Uh oh!

max-scopp commented Aug 11, 2025 •

edited

Loading

Uh oh!

bolt-new-by-stackblitz bot commented Aug 11, 2025

Uh oh!

changeset-bot bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

vercel bot commented Aug 11, 2025

Uh oh!

codecov bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Aug 11, 2025 •

edited

Loading

Uh oh!

vercel bot commented Aug 14, 2025 •

edited

Loading

Uh oh!

mrlubos Aug 14, 2025

Uh oh!

max-scopp Aug 14, 2025 •

edited

Loading

Uh oh!

mrlubos Aug 14, 2025

Uh oh!

max-scopp Aug 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mrlubos Aug 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Angular Resource Plugin #2423

Angular Resource Plugin #2423

Uh oh!

Conversation

max-scopp commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bolt-new-by-stackblitz bot commented Aug 11, 2025

Uh oh!

changeset-bot bot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel bot commented Aug 11, 2025

Uh oh!

codecov bot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

pkg-pr-new bot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mrlubos Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

max-scopp Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrlubos Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

max-scopp Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mrlubos Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

max-scopp commented Aug 11, 2025 •

edited

Loading

changeset-bot bot commented Aug 11, 2025 •

edited

Loading

codecov bot commented Aug 11, 2025 •

edited

Loading

pkg-pr-new bot commented Aug 11, 2025 •

edited

Loading

vercel bot commented Aug 14, 2025 •

edited

Loading

max-scopp Aug 14, 2025 •

edited

Loading